-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Allow event-routing-backends to be used when transforming non-openedx events #431
Conversation
Thanks for the pull request, @pomegranited! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
so that event-routing-backends can be dependency for non-edx-platform repos like openedx-completion-aggregator.
* Pulls the EVENT_TRACKING_BACKENDS configuration template into a utility method so it can be used by other apps. * Pulls allowed xAPI and Caliper events into settings to preserve changes * Adds a test
0c90c3a
to
a415ee7
Compare
…ings instead of global django.conf.settings
in class variable name and in a comment.
Refactors the transformer test classes to split the test functionality into two: * TransformersFixturesTestMixin -- for running the event fixture tests * TransformersTestMixin -- for running the ERB-specific event tests The fixtures file path constants have been moved to property methods so they can be overrideen when used outside of ERB.
This exception may occur when using ERB transformer test mixins because the fixture test files are not installed with this package.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For our use case, we were copying the mock_helpers
function to other packages to be able to extend this. This looks good to me
…tings Initialize EVENT_TRACKING_BACKENDS_ALLOWED_XAPI_EVENTS and EVENT_TRACKING_BACKENDS_ALLOWED_CALIPER_EVENTS only if they aren't already initialized, and append our events to them. This allows other plugins to modify these settings too.
and fix coverage
5685b3a
to
dc3a0f2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 👍
@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description:
Event Routing Backends is designed to be installed with edx-platform, and the code assumes this. But we want to use ERB outside of the platform too -- it contains event transform classes and test logic which is useful when transforming non-openedx events.
This PR:
See open-craft/openedx-completion-aggregator#205 for an example usage.
JIRA: FAL-3766 (private-ref)
Part of openedx/openedx-aspects#222
Merge deadline: end of June
Testing instructions:
See open-craft/openedx-completion-aggregator#205 for manual test instructions.
Merge checklist:
Post merge:
finished.